POST
/
1
/
indexes
/
{indexName}
/
synonyms
/
batch
// Initialize the client
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));

// Call the API
var response = await client.SaveSynonymsAsync(
  "<YOUR_INDEX_NAME>",
  new List<SynonymHit>
  {
    new SynonymHit
    {
      ObjectID = "id1",
      Type = Enum.Parse<SynonymType>("Synonym"),
      Synonyms = new List<string> { "car", "vehicule", "auto" },
    },
    new SynonymHit
    {
      ObjectID = "id2",
      Type = Enum.Parse<SynonymType>("Onewaysynonym"),
      Input = "iphone",
      Synonyms = new List<string> { "ephone", "aphone", "yphone" },
    },
  },
  true,
  true
);
// >LOG
{
  "taskID": 1514562690001,
  "updatedAt": "2023-07-04T12:49:15Z"
}

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
indexName
string
required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

Query Parameters

​
forwardToReplicas
boolean

Whether changes are applied to replica indices.

​
replaceExistingSynonyms
boolean

Whether to replace all synonyms in the index with the ones sent with this request.

Body

application/json · object[]

Matching synonyms.

Response

200
application/json

OK

Response, taskID, and update timestamp.